<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>ADC: settings_defines.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">ADC
   &#160;<span id="projectnumber">8.0</span>
   </div>
   <div id="projectbrief">Analog to Digital Conversor library for the Teensy 4 microprocessor</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('settings__defines_8h.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#namespaces">Namespaces</a> &#124;
<a href="#enum-members">Enumerations</a>  </div>
  <div class="headertitle">
<div class="title">settings_defines.h File Reference</div>  </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &lt;Arduino.h&gt;</code><br />
</div>
<p><a href="settings__defines_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="namespaces"></a>
Namespaces</h2></td></tr>
<tr class="memitem:namespace_a_d_c___error"><td class="memItemLeft" align="right" valign="top"> &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_a_d_c___error.html">ADC_Error</a></td></tr>
<tr class="memdesc:namespace_a_d_c___error"><td class="mdescLeft">&#160;</td><td class="mdescRight">Handle <a class="el" href="class_a_d_c.html">ADC</a> errors. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:a1edb7e48507f5c04ef3db68b5d5b01c9"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="settings__defines_8h.html#a1edb7e48507f5c04ef3db68b5d5b01c9">ADC_REFERENCE</a> : uint8_t { <a class="el" href="settings__defines_8h.html#a1edb7e48507f5c04ef3db68b5d5b01c9acbdca6103ed9d1895ad7cabeda125dac">ADC_REFERENCE::REF_3V3</a> = static_cast&lt;uint8_t&gt;(ADC_REF_SOURCE::REF_DEFAULT)
 }</td></tr>
<tr class="separator:a1edb7e48507f5c04ef3db68b5d5b01c9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac8d2892dc23aba5d30e7013804d3429b"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="settings__defines_8h.html#ac8d2892dc23aba5d30e7013804d3429b">ADC_INTERNAL_SOURCE</a> : uint8_t { <a class="el" href="settings__defines_8h.html#ac8d2892dc23aba5d30e7013804d3429bad1809a5c0e700d83d66cd3c96f5b414f">ADC_INTERNAL_SOURCE::VREFSH</a> = 25
 }</td></tr>
<tr class="separator:ac8d2892dc23aba5d30e7013804d3429b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac34be55b6924d2fde288f7e176ac62b2"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="settings__defines_8h.html#ac34be55b6924d2fde288f7e176ac62b2">ADC_CONVERSION_SPEED</a> : uint8_t { , <br />
&#160;&#160;<a class="el" href="settings__defines_8h.html#ac34be55b6924d2fde288f7e176ac62b2aaa486942a3788373f56f1955a6c97c9b">ADC_CONVERSION_SPEED::LOW_SPEED</a> = VERY_LOW_SPEED, 
<a class="el" href="settings__defines_8h.html#ac34be55b6924d2fde288f7e176ac62b2a9d9b800360e0fb88ba3d964b0b30feba">ADC_CONVERSION_SPEED::MED_SPEED</a>, 
<a class="el" href="settings__defines_8h.html#ac34be55b6924d2fde288f7e176ac62b2a78f3e093707596168b9993c4f6f8ae10">ADC_CONVERSION_SPEED::HIGH_SPEED</a>
, <a class="el" href="settings__defines_8h.html#ac34be55b6924d2fde288f7e176ac62b2ade3725f959e5b1781c4936995a5afc43">ADC_CONVERSION_SPEED::ADACK_10</a>, 
<br />
&#160;&#160;<a class="el" href="settings__defines_8h.html#ac34be55b6924d2fde288f7e176ac62b2a6cebc3a00b3b4974e1187c0fa0e096b9">ADC_CONVERSION_SPEED::ADACK_20</a>
<br />
 }</td></tr>
<tr class="separator:ac34be55b6924d2fde288f7e176ac62b2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3fc99f48d35189e64d2628def313a15d"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="settings__defines_8h.html#a3fc99f48d35189e64d2628def313a15d">ADC_SAMPLING_SPEED</a> : uint8_t { <br />
&#160;&#160;<a class="el" href="settings__defines_8h.html#a3fc99f48d35189e64d2628def313a15da5afd4ce3e51232e5889cfd918354ff2d">ADC_SAMPLING_SPEED::VERY_LOW_SPEED</a>, 
<a class="el" href="settings__defines_8h.html#a3fc99f48d35189e64d2628def313a15daaa486942a3788373f56f1955a6c97c9b">ADC_SAMPLING_SPEED::LOW_SPEED</a>, 
<a class="el" href="settings__defines_8h.html#a3fc99f48d35189e64d2628def313a15da41a5ac10a655ddab950215d9366c1803">ADC_SAMPLING_SPEED::LOW_MED_SPEED</a>, 
<a class="el" href="settings__defines_8h.html#a3fc99f48d35189e64d2628def313a15da9d9b800360e0fb88ba3d964b0b30feba">ADC_SAMPLING_SPEED::MED_SPEED</a>, 
<br />
&#160;&#160;<a class="el" href="settings__defines_8h.html#a3fc99f48d35189e64d2628def313a15da3ce1b5cfee34884796a01e03c7dc6e22">ADC_SAMPLING_SPEED::MED_HIGH_SPEED</a>, 
<a class="el" href="settings__defines_8h.html#a3fc99f48d35189e64d2628def313a15da78f3e093707596168b9993c4f6f8ae10">ADC_SAMPLING_SPEED::HIGH_SPEED</a>, 
<a class="el" href="settings__defines_8h.html#a3fc99f48d35189e64d2628def313a15da7adb06698de3374f342581b15e5f3fef">ADC_SAMPLING_SPEED::HIGH_VERY_HIGH_SPEED</a>, 
<a class="el" href="settings__defines_8h.html#a3fc99f48d35189e64d2628def313a15da605020f3fad4a24098fbbb0fa4a293f1">ADC_SAMPLING_SPEED::VERY_HIGH_SPEED</a>
<br />
 }</td></tr>
<tr class="separator:a3fc99f48d35189e64d2628def313a15d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad050c44d1f3422d02e5f9726edeee8f0"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_a_d_c___error.html#ad050c44d1f3422d02e5f9726edeee8f0">ADC_Error::ADC_ERROR</a> : uint16_t { <br />
&#160;&#160;<a class="el" href="namespace_a_d_c___error.html#ad050c44d1f3422d02e5f9726edeee8f0a03570470bad94692ce93e32700d2e1cb">ADC_Error::ADC_ERROR::OTHER</a> = 1&lt;&lt;0, 
<a class="el" href="namespace_a_d_c___error.html#ad050c44d1f3422d02e5f9726edeee8f0ae1f7d44eff22f533115c24a249c57269">ADC_Error::ADC_ERROR::CALIB</a> = 1&lt;&lt;1, 
<a class="el" href="namespace_a_d_c___error.html#ad050c44d1f3422d02e5f9726edeee8f0ab578c19f4fab8e2bfeddc85fa17b5acf">ADC_Error::ADC_ERROR::WRONG_PIN</a> = 1&lt;&lt;2, 
<a class="el" href="namespace_a_d_c___error.html#ad050c44d1f3422d02e5f9726edeee8f0a563cea047bb978769e53c9a565f9a31b">ADC_Error::ADC_ERROR::ANALOG_READ</a> = 1&lt;&lt;3, 
<br />
&#160;&#160;<a class="el" href="namespace_a_d_c___error.html#ad050c44d1f3422d02e5f9726edeee8f0ad46625d92e7d639cc2cfcce4451a11a1">ADC_Error::ADC_ERROR::ANALOG_DIFF_READ</a> = 1&lt;&lt;4, 
<a class="el" href="namespace_a_d_c___error.html#ad050c44d1f3422d02e5f9726edeee8f0a53f6b3ace3aa40916de167636293ac80">ADC_Error::ADC_ERROR::CONT</a> = 1&lt;&lt;5, 
<a class="el" href="namespace_a_d_c___error.html#ad050c44d1f3422d02e5f9726edeee8f0ac16bcb11fac967e648e4d534e2c84683">ADC_Error::ADC_ERROR::CONT_DIFF</a> = 1&lt;&lt;6, 
<a class="el" href="namespace_a_d_c___error.html#ad050c44d1f3422d02e5f9726edeee8f0a4fd4da223d344be375847dcacc013d7f">ADC_Error::ADC_ERROR::COMPARISON</a> = 1&lt;&lt;7, 
<br />
&#160;&#160;<a class="el" href="namespace_a_d_c___error.html#ad050c44d1f3422d02e5f9726edeee8f0a52df2c8ae830ed21e0c2fc269087b3ec">ADC_Error::ADC_ERROR::WRONG_ADC</a> = 1&lt;&lt;8, 
<a class="el" href="namespace_a_d_c___error.html#ad050c44d1f3422d02e5f9726edeee8f0aff3c543e04a7a5d3dac5185b45d12d09">ADC_Error::ADC_ERROR::SYNCH</a> = 1&lt;&lt;9, 
<a class="el" href="namespace_a_d_c___error.html#ad050c44d1f3422d02e5f9726edeee8f0a813461e0c58e7ad59a2fd83ca2237fec">ADC_Error::ADC_ERROR::CLEAR</a> = 0
<br />
 }</td></tr>
<tr class="memdesc:ad050c44d1f3422d02e5f9726edeee8f0"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="class_a_d_c.html">ADC</a> errors.  <a href="namespace_a_d_c___error.html#ad050c44d1f3422d02e5f9726edeee8f0">More...</a><br /></td></tr>
<tr class="separator:ad050c44d1f3422d02e5f9726edeee8f0"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a id="ac34be55b6924d2fde288f7e176ac62b2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac34be55b6924d2fde288f7e176ac62b2">&#9670;&nbsp;</a></span>ADC_CONVERSION_SPEED</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="settings__defines_8h.html#ac34be55b6924d2fde288f7e176ac62b2">ADC_CONVERSION_SPEED</a> : uint8_t</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">strong</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p><a class="el" href="class_a_d_c.html">ADC</a> conversion speed. Common set of options to select the <a class="el" href="class_a_d_c.html">ADC</a> clock speed F_ADCK, which depends on ADC_F_BUS, except for the ADACK_X_Y options that are independent. This selection affects the sampling speed too. Note: the F_ADCK speed is not equal to the conversion speed; any measurement takes several F_ADCK cycles to complete including the sampling and conversion steps. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="ac34be55b6924d2fde288f7e176ac62b2aaa486942a3788373f56f1955a6c97c9b"></a>LOW_SPEED&#160;</td><td class="fielddoc"><p>is guaranteed to be the lowest possible speed within specs for all resolutions. </p>
</td></tr>
<tr><td class="fieldname"><a id="ac34be55b6924d2fde288f7e176ac62b2a9d9b800360e0fb88ba3d964b0b30feba"></a>MED_SPEED&#160;</td><td class="fielddoc"><p>is always &gt;= LOW_SPEED and &lt;= HIGH_SPEED. </p>
</td></tr>
<tr><td class="fieldname"><a id="ac34be55b6924d2fde288f7e176ac62b2a78f3e093707596168b9993c4f6f8ae10"></a>HIGH_SPEED&#160;</td><td class="fielddoc"><p>is guaranteed to be the highest possible speed within specs for resolutions </p>
</td></tr>
<tr><td class="fieldname"><a id="ac34be55b6924d2fde288f7e176ac62b2ade3725f959e5b1781c4936995a5afc43"></a>ADACK_10&#160;</td><td class="fielddoc"><p>10 MHz asynchronous <a class="el" href="class_a_d_c.html">ADC</a> clock (independent of the global clocks F_CPU or F_BUS) </p>
</td></tr>
<tr><td class="fieldname"><a id="ac34be55b6924d2fde288f7e176ac62b2a6cebc3a00b3b4974e1187c0fa0e096b9"></a>ADACK_20&#160;</td><td class="fielddoc"><p>20 MHz asynchronous <a class="el" href="class_a_d_c.html">ADC</a> clock (independent of the global clocks F_CPU or F_BUS) </p>
</td></tr>
</table>

</div>
</div>
<a id="ac8d2892dc23aba5d30e7013804d3429b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac8d2892dc23aba5d30e7013804d3429b">&#9670;&nbsp;</a></span>ADC_INTERNAL_SOURCE</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="settings__defines_8h.html#ac8d2892dc23aba5d30e7013804d3429b">ADC_INTERNAL_SOURCE</a> : uint8_t</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">strong</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Other <a class="el" href="class_a_d_c.html">ADC</a> sources to measure, such as the temperature sensor. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="ac8d2892dc23aba5d30e7013804d3429bad1809a5c0e700d83d66cd3c96f5b414f"></a>VREFSH&#160;</td><td class="fielddoc"><p>internal channel, for <a class="el" href="class_a_d_c.html">ADC</a> self-test, hard connected to VRH internally </p>
</td></tr>
</table>

</div>
</div>
<a id="a1edb7e48507f5c04ef3db68b5d5b01c9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1edb7e48507f5c04ef3db68b5d5b01c9">&#9670;&nbsp;</a></span>ADC_REFERENCE</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="settings__defines_8h.html#a1edb7e48507f5c04ef3db68b5d5b01c9">ADC_REFERENCE</a> : uint8_t</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">strong</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Reference for the <a class="el" href="class_a_d_c.html">ADC</a> </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a1edb7e48507f5c04ef3db68b5d5b01c9acbdca6103ed9d1895ad7cabeda125dac"></a>REF_3V3&#160;</td><td class="fielddoc"><p>3.3 volts </p>
</td></tr>
</table>

</div>
</div>
<a id="a3fc99f48d35189e64d2628def313a15d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3fc99f48d35189e64d2628def313a15d">&#9670;&nbsp;</a></span>ADC_SAMPLING_SPEED</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="settings__defines_8h.html#a3fc99f48d35189e64d2628def313a15d">ADC_SAMPLING_SPEED</a> : uint8_t</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">strong</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p><a class="el" href="class_a_d_c.html">ADC</a> sampling speed. It selects how many ADCK clock cycles to add. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a3fc99f48d35189e64d2628def313a15da5afd4ce3e51232e5889cfd918354ff2d"></a>VERY_LOW_SPEED&#160;</td><td class="fielddoc"><p>is the lowest possible sampling speed (+22 ADCK, 24 in total). </p>
</td></tr>
<tr><td class="fieldname"><a id="a3fc99f48d35189e64d2628def313a15daaa486942a3788373f56f1955a6c97c9b"></a>LOW_SPEED&#160;</td><td class="fielddoc"><p>adds +18 ADCK, 20 in total. </p>
</td></tr>
<tr><td class="fieldname"><a id="a3fc99f48d35189e64d2628def313a15da41a5ac10a655ddab950215d9366c1803"></a>LOW_MED_SPEED&#160;</td><td class="fielddoc"><p>adds +14, 16 in total. </p>
</td></tr>
<tr><td class="fieldname"><a id="a3fc99f48d35189e64d2628def313a15da9d9b800360e0fb88ba3d964b0b30feba"></a>MED_SPEED&#160;</td><td class="fielddoc"><p>adds +10, 12 in total. </p>
</td></tr>
<tr><td class="fieldname"><a id="a3fc99f48d35189e64d2628def313a15da3ce1b5cfee34884796a01e03c7dc6e22"></a>MED_HIGH_SPEED&#160;</td><td class="fielddoc"><p>adds +6 ADCK, 8 in total. </p>
</td></tr>
<tr><td class="fieldname"><a id="a3fc99f48d35189e64d2628def313a15da78f3e093707596168b9993c4f6f8ae10"></a>HIGH_SPEED&#160;</td><td class="fielddoc"><p>adds +4 ADCK, 6 in total. </p>
</td></tr>
<tr><td class="fieldname"><a id="a3fc99f48d35189e64d2628def313a15da7adb06698de3374f342581b15e5f3fef"></a>HIGH_VERY_HIGH_SPEED&#160;</td><td class="fielddoc"><p>+2 ADCK, 4 in total </p>
</td></tr>
<tr><td class="fieldname"><a id="a3fc99f48d35189e64d2628def313a15da605020f3fad4a24098fbbb0fa4a293f1"></a>VERY_HIGH_SPEED&#160;</td><td class="fielddoc"><p>is the highest possible sampling speed (0 ADCK added, 2 in total). </p>
</td></tr>
</table>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="settings__defines_8h.html">settings_defines.h</a></li>
    <li class="footer">Generated on Tue Dec 31 2019 13:18:47 for ADC by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.17 </li>
  </ul>
</div>
</body>
</html>
